Skip to main content

Read

Description

Google Spreadsheets: Read step reads a spreadsheet on Google Drive.

Configurations

No.Field NameDescription
1Step nameName of the step as it appears in the workflow workspace. This name has to be unique in a single workflow.
Connection:Refer Prerequisites and References above to get the connection attributes.
2Client IDSpecify Client ID of the Google application.
The data type is String. This field is mandatory.
Client Secret:
3Accept Values from fieldsLeave checkbox unchecked to accept Client Secret value from a field in the previous steps of the stream using a drop down list.
Else enable checkbox for Secret Key field to appear as Text box.
4Client SecretSpecify Client Secret of the Google application.Client Secret is entered using a widget. If checkbox above is enabled Client Secret field appears as Text box and accepts static values or variables. Else if checkbox above is disabled Client Secret field appears as a drop down containing values from previous steps - to select from.
The data type is String. This field is mandatory.
Refresh Token:
5Accept Values from fieldsLeave checkbox unchecked to accept Secret Key value from a field in the previous steps of the stream using a drop down list.
Else enable checkbox for Secret Key field to appear as Text box.
6Refresh TokenSpecify a Refresh Token to obtain a new Access Token.
Note: Refresh Token expires if idle for 6 months.
Refresh Token is entered using a widget. If checkbox above is enabled Refresh Token field appears as Text box and accepts static values or variables. Else if checkbox above is disabled Refresh Token field appears as a drop down containing values from previous steps - to select from.
The data type is String. This field is mandatory.
7Button: Test ConnectionVerifies whether the connection is established or not.
Note: For the purpose of verification fields coming from previous steps are not allowed since field values can only be accessed when workflow is in running state; only static values and environment variables are allowed.
Input Fields:
1Spreadsheet IDSpecify the unique ID allocated to the spreadsheet. This ID is the value between the "/d/" and the "/edit" in the URL of your spreadsheet.
For example, Spreadsheet ID reference URL - For example, consider the following URL that references a Google Sheets spreadsheet: https://docs.google.com/spreadsheets/d/1CJnkal5pj3SLpv-HdmyguX/edit#gid=0
Then, Spreadsheet ID is: 1CJnkal5pj3SLpv- HdmyguX) as highlighted above.
2RangeRange should be provided in A1 notation.
This is a string like Sheet1!A1:B2, that refers to a group of cells in the spreadsheet, and is typically used in formulas.
3Has Header?Allowed values are Yes or No. Set Yes if header row is present in the retrieved data.
If this option is set to Yes, then values present in all columns in the first row will be populated in Field Name in the Output tab below; else dummy column names such as Field_000, Field_001 and so on will be populated.
Output tab
1Button: Get Output FieldsClick this button to populate header field names (or columns) to be read from spreadsheet in the tabular Field Names below.
Note: On an ongoing basis please click Get Output Fields button to after any change in any of the above input fields.
Table Fields:
2Field NameSpecify the Field Names (or columns) to fetch from the range specified in the input Tab. The Field Names are fetched by clicking the Get Output Fields button above. You may Keep all the Field Names retrieved or deleted the fields names not required.
If Has Header is set to Yes in the Input Tab, then values present in all columns in the first row are populated in the Field name.
If Has Header is set to No, then the dummy column names such as Field_000, Field_001 and so on are populated.
The following is true of the rows of data read from the range specified,
- If Has Header=Yes and you wish to fetch the columns of rows data that do not have a value in the first row of header Field Name then alternatively provide an Output Field Name below, to match the columns of rows data.
- In case of merged cells, the value is assigned to the top left cell.
- In a row, if a cell is empty it is marked as <null>, and also in case there are no consecutive cells having data after that cell then the value of such cells is also marked as <null>.
Note: At least one combination of Field Name and Output Field Name should be provided.
3Output Field NameYou may specify desirable names for the Field Names above; especially when ‘Has Header’=No and Field Names do not represent appropriate business names.
Note: At least one combination of Field Name and Output Field Name should be provided.